home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / ada / gwuada_0.zip / readme.nyu < prev    next >
Text File  |  1994-06-21  |  24KB  |  552 lines
  1. This is the original NYU documentation for Ada/Ed.
  2.  
  3. 1. INTRODUCTION.
  4.  
  5. This file is the README file from the distribution of Ada/Ed version
  6. 1.11.2-PC, an Ada interpreter for 386/486 machines running MS-DOS/PC-DOS.
  7.  
  8. This program is free software; you can redistribute it and/or modify
  9. it under the terms of the GNU General Purpose License as published by
  10. the Free Software Foundation; either version 2 of the License, or
  11. (at your option) any later version. See relevant excerpts below.
  12.  
  13. Ada/Ed is a translator-interpreter for Ada. It is intended as a teaching
  14. tool, and does not have the capacity, performance,  or robustness of 
  15. commercial Ada compilers. Ada/Ed was developed at New York University, as
  16. part of a long-range project in language definition and software prototyping. 
  17. The project produced the first validated translator for Ada, in the form of
  18. an executable definition of the language written in SETL. The SETL system
  19. served as design document and prototype for the C version being released today.
  20.  
  21. Ada/Ed was last validated under version 1.7 of the ACVC tests. Therefore it is
  22. not currently a validated Ada system, and users can expect to find  small
  23. discrepancies between Ada/Ed and currently validated compilers. 
  24.  
  25. Apart from the 100-odd tests of ACVC 1.11 that Ada/Ed currently fails, the
  26. major deficiency of the system is that, being an interpreter, it does not 
  27. implement most representation clauses, and thus does not support systems 
  28. programming close to the machine level. 
  29.  
  30. We trust that even with these limitations, Ada/Ed will be of use to the
  31. Ada community at large: students, educators, user, and implementors. The 
  32. sources of the system should be of interest to compiler writers, and we hope 
  33. that they will encourage the construction of software tools to make the system
  34. more usable and polished. The NYUADA project does not have the resources to
  35. promise regular new maintenance releases of the software, but will do its
  36. best to keep track of reported errors, workarounds, and fixes. We will also
  37. produce at irregular intervals design notes and additional documentation on
  38. the front-end of the system.  We  urge users to send comments, corrections 
  39. and bug reports (reduced to their simplest form!)  to:   adaed@cs.nyu.edu
  40.  
  41.  
  42. All users of Ada/Ed are urged to register themselves by
  43. sending email to the above address, or to the NYUADA project, New
  44. York University, 251 Mercer Street, New York, NY 10012. This will allow us to
  45. notify users of updates and new releases of the system.
  46.  
  47.  
  48. 2. (UN) WARRANTY
  49.  
  50. This software is release 1.11.2-PC of the Ada/Ed system.
  51. It is distributed absolutely WITHOUT ANY WARRANTY; without even the implied 
  52. warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  53. General Public License for more details.
  54.  
  55. To receive a copy of the GNU General Public License write to the Free
  56. Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139.
  57.  
  58. The following is an excerpt from the GNU General Public License concerning
  59. warranties:
  60.  
  61. Because the program is licensed free of charge, there is no warranty
  62. for the program, to the extent permitted by applicable law.  Except when
  63. otherwise stated in writing the copyright holders and/or other parties
  64. provide the program "as is" without warranty of any kind, either expressed
  65. or implied, including, but not limited to, the implied warranties of
  66. merchantability and fitness for a particular purpose.  The entire risk as
  67. to the quality and performance of the program is with you.  Should the
  68. program prove defective, you assume the cost of all necessary servicing,
  69. repair or cowriting
  70. will any copyright holder, or any other party who may modify and/or
  71. redistribute the program as permitted above, be liable to you for damages,
  72. including any general, special, incidental or consequential damages arising
  73. out of the use or inability to use the program (including but not limited
  74. to loss of data or data being rendered inaccurate or losses sustained by
  75. you or third parties or a failure of the program to operate with any other
  76. programs), even if such holder or other party has been advised of the
  77. possibility of such damages.
  78.  
  79. 3. INSTALLATION
  80.  
  81. To intall Ada/Ed choose a directory to contain the executables and
  82. library files; include this directory on the PATH; set the environment
  83. variable ADAED to the pathname for this directory; and copy the files
  84. *.exe, predef.axq, predef.trc, and predef.lib into the directory.
  85.  
  86. For example, if the directory chosen is C:\ADAED, then the AUTOEXEC.BAT
  87. might contain lines such as:
  88.  
  89. PATH=C:;C:\ADAED
  90. SET ADAED=C:\ADAED
  91.  
  92. If you already have a number of SET commands in your AUTOEXEC.BAT file
  93. then you might not be able to add the additional SET commands needed
  94. for Ada/Ed-C. If you have DOS 3.2 (or later) this can be overcome by 
  95. adding the following to your CONFIG.SYS file:
  96.      SHELL=C:\COMMAND.COM /P /E:320
  97. For DOS 3.2 the E: option tells DOS to allocate the specified number
  98. of bytes for the environment. The first argument points to a copy 
  99. of COMMAND.COM on the hard disk; adjust this if you do not keep
  100. COMMAND.COM in the root directory. This command also works (but is
  101. not doumented) under DOS 3.1, but for DOS 3.1, the argument is in
  102. paragraphs rather that bytes (so write /E:20 to get 320 bytes).
  103.  
  104. Before using the compiler you must make sure that your CONFIG.SYS file
  105. allows the system to open at least 12 files. Check this by looking in 
  106. your CONFIG.SYS file for the following line:
  107.      FILES=number
  108. If number is less that 12, edit the CONFIG.SYS and set number to a value 
  109. not less that 12. If you do not currently have a CONFIG.SYS file, create 
  110. a file of that name on your system disk (or root diectory if you boot from 
  111. a hard disk) and insert the following line:
  112.      FILES=12
  113.  
  114. Note that if the value of FILES is too small, you will get the message
  115. "Unable to open file ..." when compiling even the simplest program.
  116.  
  117. You may also want to use the BUFFERS command to specify a larger number of
  118. buffers. This is not required, but specifying more that the default number
  119. of buffers should substantially improve Ada/Ed-C performance. A minimum 
  120. value of 15 is recommended, so add
  121.      BUFFERS=15
  122. to your CONFIG.SYS file. A value larger than 15 will further increase 
  123. performance, however it might begin to decrease the size of programs that
  124. can be compiled by decreasing the available memory.
  125.  
  126. Try some of the supplied demo program (see the readme in the demos directory)
  127. Also look at the release.notes for more information about the system and
  128. the changes that have take place.
  129.  
  130. 4. REBUILDING
  131.  
  132. Ada/Ed is written in C, and built using Intel's 386/486 C Code Builder.  
  133. The sources and makefile for doing this are part of the distribution.  To
  134. rebuild, read the makefile and execute "make" and "make predef.lib" or
  135. just "make predef.lib".  In particular, note the comment in the makefile
  136. about the include file makeext.  After rebuilding, follow the installation
  137. instructions above.
  138.  
  139.  
  140. 5. USING Ada/Ed
  141.  
  142. The Ada/Ed system includes the following commands:
  143.  
  144.  adacomp     [ -abgsv ] [ -m  main_unit ] [ -n ] [-l library ]  file
  145.  
  146.  adabind     [ -m  main_unit ]  [-l library]
  147.  
  148.  adaexec     [ -h heap] [ -m   bound_main_unit ] [-p pstack] [-s  tstack]
  149.              [ -r nb_stmts] [ -t [acerst] ]   [-l library]
  150.  
  151.  adalib      [-l library]
  152.  
  153. Description
  154.  
  155. Ada/Ed is a translator/interpreter for the Ada programming language that
  156. is intended primarily for educational use.
  157.  
  158. Adacomp compiles an Ada program; it invokes in succession the two
  159. compilation phases: parsing and semantic analysis (the front end) ,and 
  160. code generation.  The file argument refers to the source file; if no 
  161. extension is given for it, the extension ADA is assumed. The file argument 
  162. may contain drive and directory specifications.  The output of the compiler 
  163. is an instruction stream for an abstract Ada machine, which is then 
  164. interpreted.
  165.  
  166. Adabind binds a given library with the specified main unit to form an
  167. executable program.
  168.  
  169. Adaexec invokes the Ada machine interpreter for the bound program given in 
  170. the specified library. 
  171.  
  172. Adalib displays the contents of the specified library.
  173.  
  174. Note :  All options must precede the file name and may be in either lowe